Shareware Grab Bag

home *** CD-ROM | disk | FTP | other *** search

/ Shareware Grab Bag / Shareware Grab Bag.iso / 002 / fsed.arc / FSED.DOC < prev

Wrap

Text File | 1984-11-24 | 80.0 KB | 2,377 lines

FSED A Full Screen Editor for The IBM Personal Computer Version 2.0 Copyright 1983 by D. W. Daetwyler 1 Full Screen Editor - Version 2.0 TABLE OF CONTENTS Page PREFACE 3 INTRODUCTION 4 STARTING OUT 5 EDITING A FILE 9 COMMANDS 12 SCROLLING 13 CURSOR MOVEMENT 14 CHARACTER MANIPULATION 16 LINE MANIPULATION 17 SEARCH 19 FILE CONTROL 20 EDITOR CONTROL 22 MISCELLANEOUS 24 CONCLUSION 26 ERROR MESSAGES 27 APPENDIX A 29 APPENDIX B 30 APPENDIX C 32 APPENDIX D 33 QUICK REFERENCE 34 Table of contents 2 Full Screen Editor - Version 2.0 EPREFACEF This is a T.P.I.R product! (The Price Is... Reasonable?) I object to paying half the price of my hardware for a single software package, so I'm trying to do something about it. I believe that there are enough "micros" around to make a reason- able return on your labor investment through volume... if you don't have to pay substantive advertising and marketing costs. If you're reading this document, you have the package. It is copyrighted, so what are your rights? They are given here: -- You are free to copy, and encouraged to distribute to any/all of your friends, the materials included in the distribution diskettte. Please include this document. -- You may use these materials in any way you see fit, but you may not "sell" the package. Where's the "catch"? Simple. Its up to you. If you use this package, and like it, send me a check for $35. Otherwise, thanks for experimenting! What do you get for the $35, besides a clear conscience? Not much. I'll put you on my mailing list and when (not if) bugs are encountered, I'll notify you and offer our handy, dandy copy service, which incidentally is available to all your friends for their initial copy, if you don't want to bother copying the diskette. I'll also notify you when future develop- ments are available: we now have the Screen Design Aid, a util- ity that takes a lot of the drudgery out of building interactive menus; the LIST utility, which allows for "wild card" print requests, optionally provides headings, and fully supports all of the many and varied modes of printing without messing with the MODE command; and a Full Screen Editor, primarily for programming, which supports either display interface, provides very "full function", and is FAST. All operate on PC-DOS V1.x or V2.0. The copy service mentioned is also simple: Send diskette, mailer, and enough postage to the writer and we'll make a copy of the distribution diskette for you. If you don't want to send the diskette, mailer, et al., send a check for $7.50 and we'll send you a new diskette with the materials (Single surface, 8 sector). The last page of this document is an order/registration form. DISCLAIMER (Or I really don't want to be sued!) Although reasonable testing has been conducted, under no circumstances will the author be liable to you or any third party for any damages, including lost profits or other incidental or consequential damages arising out of the use of, or the inability to use, this software. Further the offers made in this document are subject to withdrawal at any time and without notification, and prices quoted are subject to change without notice. Preface 3 Full Screen Editor - Version 2.0 INTRODUCTION The Full Screen Editor (FSED) is primarily a programming development tool for the applications or systems programmer. It is designed to work with the IBM Personal Computer, using either the Monochrome Display or the Color/Graphics interface, and at least one disk. Although the editor will operate on machines with as little as 64K bytes of memory, its design point for optimum operation is the 128K memory system. As an environment, it expects the IBM Disk Operating System (DOS) Versions 1.x or 2.0, and uses the facilities of this operating system as well as the facilities of the Basic Input/Output System (BIOS). Although programming language independent, the editor will be of most use to the programmer using Assembler, PASCAL, or FORTRAN. The BASIC programmer's use of the editor will probably be limited to selected special functions (eg: search for a vari- able name), and no specific format processor for BASIC is in- cluded in the editor. Users of the BASIC Compiler will find the editor useful, however. Similarily, although selected functions permit the use of the editor for "text" processing, these tools are limited and primitive when compared to a normal, full func- tion, text processor. The editor works with "files" which are normal DOS files in ASCII or source form. Files to be processed by this editor are limited to "lines" of not greater than 80 characters. * * * WARNING * * * If editing is attempted on files containing lines of more than 80 characters, truncation will occur and portions of the data will be lost. Under certain conditions, attempting to apply functions against these lines may cause catastrophic error!!! Using the facilities of the editor, the programmer may: create or modify source language files, extract portions of existing files, insert existing files into other files, or use existing files to create new files. Twenty-four lines of source are normally displayed during all editing functions, and pro- vision is made for "paging" through files by displaying sucessive pages. Characters can be changed, deleted, or inserted into existing lines. New lines may be added, existing lines deleted, moved, or copied. Finally, a substantial number of "control" functions can be exercised, most by the depression of a single key. All of the functions, with the exception of those that are limited by disk speeds, are performed at speeds essentially within the human response range. Introduction - 4 Full Screen Editor - Version 2.0 STARTING OUT Since the Full Screen Editor requires IBM DOS to operate, it is assumed that you are familiar with the terms and conventions of the DOS. File names and disk operations are those supported by the standard DOS, so no attempt is made to cover this material in this document. In an attempt to keep this document simple, many details of functioning are omitted from the main discussion. These details are generally not important to the typical user, however since they may effect some unique process you are attempting they are included in the set of appendicies appearing at the back of this document. When the general area effected by the appendix is first discussed a parenthetical reference is included (eg: Appen- dix A). You should read through the material as it is presented, omitting the appendicies during your first use of the editor. As your familiarity grows and you attempt more complex use, then reference to the appendicies will resolve most questions that may arise. This document is written for the "new" programmer. For the experienced programmer, scanning this introductory material should be sufficient. The largest section of this document, "COMMANDS", should be reviewed by all users, and will provide a ready reference during productive use of the editor. SAVING THE EDITOR The distribution diskette included with this manual contains a file named FSED.COM. Your first action should be to copy this file to a work diskette containing your IBM DOS. Use the Copy utility included with your DOS, following the instructions pro- vided in the DOS manual. File and save your distribution disk- ette as your "master". The distribution diskette is "file pro- tected" which will prevent accidental destruction of your "master". USING THE EDITOR The editor will operate properly on either one or two drive systems. Initially, we'll use it by inserting the work diskette containing IBM DOS and the FSED.COM file in the drive "A". To start the editor you may use any of three forms of DOS commands: A:>FSED A:>FSED yourfile.type A:>FSED yourfile.type outfile.type As you gain familiarity with the editor, the second form shown above is the one you'll use most frequently. To help you get started, we'll discuss all three forms and the editor's response to each. Starting Out - 5 Full Screen Editor - Version 2.0 In all three cases, when you enter this command, the screen will briefly display an identification screen that simply announ- ces the editor has been loaded properly. If you have used the first form of the command, a prompt near the bottom of the screen will ask for your file name. Just as in the second and third forms of the command, the file name requested is a "fully quali- fied" DOS file name. Drive may be specified, and if it is not then the "default" or signed on drive is implied. "type" is not required by the editor, but most language processors do require it, so normally it should be specified. If the file you have named exists on the drive you have specified or defaulted to, then the first 24 source lines of the file will be displayed without further action. If the directory does not contain the name you gave, then a prompt will appear at the bottom of the screen: "New file - (Y or N)" If you are actually creating a new file, reply "Y" and you will be presented with a "blank" screen containing only the editor prompt line (line 25), and an "end of file" marker line. If you have made an error in specification of your file name, reply "N", and the editor will prompt for the correct name, just as it did when the first form of the command was used to initiate the editor. Before discussing the third form of the command, it is necessary to understand how the editor handles file names and directory updates. The editor is designed to prevent catastrop- hic data loss. If you are updating an existing file, that file in its original form, will still exist at the conclusion of the edit process. Editing the file actually causes the creation of a new file containing the edit changes, and normally named the same as the file specified as "yourfile" in the command or prompt sequences. The original file is renamed to "yourfile.BAK". If "yourfile.BAK" existed prior to the start of the editor, the old backup file will be automatically deleted. This complicated sounding process simply results in maintenance of two versions of "yourfile". The current version and one back up version without the last set of changes. For the editor to function properly, then, there must always be sufficient disk space available on the output drive, to con- tain the entire file being edited, plus any changes you introduce in this edit process. This is a "free space" requirement that is in addition to any "back up" files and the original file to be edited, that may already reside on the disk. The third form of the command over-rides this process. "outfile.type" is your desired name for the new file created by the editor. When this form of the command is used, the original file is not changed, and the rename to a back up file is not performed. Note that the output file need not reside on the same drive as the input file, in two drive configurations. Drive Starting Out - 6 Full Screen Editor - Version 2.0 identifier may be specified with the "outfile" name. Finally, there is one additional prompt that you will rarely see. If you have used the third form of the command and have given a name for your output file that already exists, then a prompt that warns you of this condition will appear, and you are requested to give permission to proceed ("Y") or cancel ("N"). If you permit the editor to continue, the content of the existing file will be over-written and lost!!! (Appendix A). Before proceeding into the edit process, a brief discussion of file sizes and drive configurations is appropriate. The editor is capable of processing a "very large" file, essentially limited only by the diskette capacity and the "space requirement" cited in the previous paragraphs. In actual practice, you will find it much more convienent to work with small or moderate sized files. The primary difference to the user is how "automatic" the editor appears, but good programming practice encourages file sizes that are optimum for the editor (Appendix B). On a 128K memory configuration, the editor will automatically handle files of 48K size, which in view of the very dense form of the disk stored materials, is a very large program. It is possible to load the editor and then replace it with a "work" diskette. This mode of operation requires the first form of the commands shown above. * * * WARNING * * * At the point the editor has been informed of the file names and drives that it is to work with (load time for all but the first command form), the diskette that is to contain the output file may not be removed from the drive until editing is complete, or unless specifically requested by the editor. A useful hint for multiple drive system owners is to "sign on" to the "B" drive, place the DOS diskette with the editor in the "A" drive, and your source/work diskette in the "B" drive. A command of the form: B:>A:FSED yourfile.type will permit loading of the editor from the "A" drive, but all file references (input and output) will automatically be against the "B" drive. DISPLAY DEVICES The editor will function properly on either the normal IBM Monochrome Display (or equivalent), or on a monitor driven by the Color/Graphics interface. In the latter case, the monitor must be capable of displaying 80 character lines with readable resolution. Generally, this will not permit use of so called "composite" monitors or "T.V." sets. Starting Out - 7 Full Screen Editor - Version 2.0 The display device in use prior to loading the editor, will be used by the editor. If you have both types of display interfaces, you may switch from one to the other. Switching may occur at any time during the actual edit process (not while the "title" screen is displayed), and causes no data loss. Switching is caused by depressing and holding the "Alt" key, and then depressing the "S" key. This is the only editor command that is not included in the "help" screens, so if you expect to use it, you'd better make note of it. It is not included since the function is of limited operational value. It is included simply to make it easy for you to decide which display device you will use for normal operations. Starting Out - 8 Full Screen Editor - Version 2.0 EDITING A FILE For your first use of the editor, it is easier to follow this discussion if you actually edit a small file. Since the editor loads in the default format, Assembler, copying a small assembler source file to the edit or a work disk, and then following the start up procedures outlined in the previous sec- tion is recommended. You should edit a copy, since you'll probably want to make unusual changes while experimenting with the editor. There is a command that lets you "cancel" your actions without effecting your original file, but just in case... start out with a copy. THE PRIMARY SCREEN The primary screen you will be working with is displayed immediately after editor initialization. The screen is divided into two main sections: an editing area, and a control area. The division is a bit disproportionate, since the first twenty-four lines are the editing area, while the 25th line is the control area. Look first at the 25th line. This line contains a series of "prompts" assigning the program function keys (F1-F10) to editor processes. The processes displayed are the most commonly used editor services, and are invoked by simply depressing the corresponding function key. The function keys also support a less frequently used set of processes, but in this case it is necessary to depress the "Alt" key and hold it, depressing the function key. These extended functions will be discussed later, so for now, simply consider the displayed functions. As you use the editor, the function key display on the prompt line will be replaced by an actual "prompt" from time to time. Any instructions the editor wishes to give you, error conditions sensed, and information displays are shown in this area. Most "error" messages are accompanied by an audible signal. Typically, the next command executed will cause the prompt line to return to the normal function key display. The right end of the prompt line contains "active" elements. First, you'll notice the letter "R:" followed by two digits, and then the letter "C:" followed by two digits. This is the row and column number of the current cursor position (upper left corner is 01, 01). Finally, you'll see the letter "F:" followed by either an "A", "T", or an "I". This is the "format" the editor is currently using. Format will be discussed at length, later in this document. The editor's default format is "A" (Assembler), which is what you'll see on this initial display. If the file you are editing is less than 24 lines, or if you are creating a new file, the last non-blank line in the editing area of the screen will contain an "end of file" flag. This line will also appear if you page forward to the end of your source file, as you will see when you exercise the scrolling commands. In any case, if the flag line actually reads "end of stack", you are either editing a very large file, or you have a very small File Editing - 9 Full Screen Editor - Version 2.0 memory configuration, and you must read Appendix B before proceeding. DATA ENTRY/COMMANDS The editor is designed with a "what you see is what you get" philosophy. Data entry is accomplished by simply keying non- command keys. The corresponding character will appear at the current cursor position on the screen, and the cursor will be advanced. Positioning the cursor to existing data, and keying replacement data "over the top", replaces the existing data. All alphanumeric and special character keys are acceptable as data. The program function keys, "Esc", tab, "Ctrl", backspace, enter, and all of the keys of the numeric key pad (right end of the keyboard) are "command keys" and may cause the editor to perform a command rather than performing data entry. The "Num Lock" and "Scroll Lock" keys are not used by the editor, but because of their particular signifcance to DOS, should be avoided. Try depressing one of the arrow keys on the numeric key pad. The cursor should move in the indicated direction. If, by chance, the corresponding numeric digit appears on the screen instead, then you have inadvertently depressed the "Num Lock" key. Depress it again, and then try the arrow key, which should now work properly. Now try depressing the "PgDn" key. The display should change to the "next" increment of your source file. "PgUp" will restore you to your original position. Try paging "up" when you are at the start of your file. Nothing happened, right? The same is true when you are positioned near the end of your file and you try to page "down". You can page around your file, and by using the arrow keys of the key pad, position the cursor to various locations and over write some of the file. Experiment with these functions until you're comfortable with them. Now you're ready for an important concept of the editor. As you key changes into the screen, the corresponding change is NOT made in the file. Each non-cursor movement command WILL cause the screen changes to be made in the file. To see how this works, try overwriting some area of the screen. Now depress function key 8 (Cancel). The original information re-appears on the screen, right? Now do the same thing, but this time depress function key 9. The screen will blink, and now try function key 8. This time the original data did not reappear! Function key 9 "forces" changes shown on the screen to be made in the file. Its use is not normally required, since any non-cursor movement command will force changes. To demonstrate this, key over an area and scroll forward or backward. Reverse your scroll to return to the original area, and you will find the changed data remains changed. Scrolling commands, as you should expect, force changes. This capability is an important one. Assume you have been making a number of changes on the screen, and suddenly realize that you're in the wrong area of the program. Simply depressing File Editing - 10 Full Screen Editor - Version 2.0 function 8 will cancel all changes you've made...as long as you haven't entered a command in the mean time. Rather than taking you through the individual commands on a step by step basis, you should proceed on your own through the Command section which follows. Experiment with each of the commands, and observe the result on your screen. By the time you have gone through the Command section, you'll be ready to use the editor as a production tool. Three commands will be briefly mentioned here, since they may be needed before you reach them in the command descriptions. Function key 10 will end the edit. If you use this command, your original file will be renamed, and the new file with your edit changes will be created. Since that may not be what you want to do with this "test" file, try holding the "Alt" key depressed while you depress function key 10. A prompt that asks if you want to "abort" this edit will appear, and a response of "Y" will cause your original input file to remain unchanged, while the new file will not be created. Finally, depressing and holding the "Alt" key and then depressing "h" or "H" will cause a "help" menu to be displayed. This, and its successor menu, contains all but one of the com- mands available under the editor. Its intended to be a handy "quick reference", so you're strongly encouraged touse it fre- quently. The omitted command is the "Alt-S", used to switch between display devices. When you leave the "help" function, the screen you were working reappears, but remember that "help" is a command, so any changes pending on the screen will be forced to the file by your request for "help". File Editing - 11 Full Screen Editor - Version 2.0 COMMANDS This section discusses each of the available commands in relative detail. It is organized into eight sub-sections, in which commands of a similar nature are grouped. The sub-sections are: Scrolling Commands Cursor Movement Commands Character Manipulation Commands Line Manipulation Commands Search Commands File Control Commands Editor Control Commands Miscellaneous Commands The balance of this section examines each of the commands. Commands - 12 Full Screen Editor - Version 2.0 SCROLLING COMMANDS The scrolling commands permit the user to "page" through the primary increment. All scroll commands "force" screen changes to the file. SCROLL UP BY "INCREMENT" Key: "PgUp" Causes the sreen "window" to move towards the "top" of the source file by the current increment. See SET SCROLLING INCREMENT below. SCROLL UP BY LINE Key: CTRL("PgUp") Causes the screen "window" to move towards the "top" of the source file by one line. SCROLL TO "TOP" OF SOURCE STACK Key: "Home" Causes the screen "window" to move to the "top" of the source file in memory. SCROLL DOWN BY "INCREMENT" Key: "PgDn" Causes the screen "window" to move towards the "bottom" of the source file in memory, by the current increment. See SET SCROLLING INCREMENT below. SCROLL DOWN BY LINE Key: CTRL("PgDn") Causes the screen "window" to move towards the "bottom" of the source file in memory, by one line. SCROLL TO END OF SOURCE STACK Key: CTRL("Home") Causes the screen "window" to move to the "bottom" of the source file in memory. SET SCROLLING INCREMENT Key: ALT(F6) The default increment for scrolling is the "half page", so unless this command is utilized, scrolling by "increment" will cause the window to advance by 12 lines. This command causes a prompt message to be displayed requesting a user response of "H" or "F" (Half page increment or Full page increment). In full page mode, the window will be advanced by 23 lines. The physical position of the cursor remains constant during scrolling, so if the cursor is positioned to the 20th line before scrolling, it will remain at this position (20th line) after scrolling. Scrolling Commands - 13 Full Screen Editor - Version 2.0 CURSOR MOVEMENT COMMANDS Cursor movement permits positioning to any column of the twenty-four line data entry area. Movement does not effect data, nor does it force screen changes to the file. Data is always entered at the "current cursor position", so these commands are used more frequently than any other editor process, with the exception of data entry. Cursor movement will cause the row/column portion of the prompt line display to change to reflect the new position of the cursor. CURSOR UP (ONE LINE) Key: Up Arrow Moves the cursor up one row, retaining column position. If already positioned to row 1, cursor "wraps" to row 24. CURSOR DOWN (ONE LINE) Key: Down Arrow Moves the cursor down one row, retaining column position. If already positioned to row 24, cursor "wraps" to row 1. CURSOR LEFT ONE CHARACTER Key: Left Arrow (Either) Moves the cursor one column to the left, retaining row position. If already positioned to column 1, cursor "wraps" to column 80. CURSOR RIGHT ONE CHARACTER Key: Right Arrow Moves the cursor one column to the right, retaining row position. If already positioned to column 80, cursor "wraps" to column 1. CURSOR LEFT ONE WORD Key: CTRL(Left Arrow) Moves the cursor to the start of the next full word to the left of its current position. When reaching column 1, the cursor will NOT "wrap", but will remain in column 1. "Word" is defined as any non-blank string, delineated by blank, tab, comma, colon, left bracket, right bracket. CURSOR RIGHT ONE WORD Key: CTRL(Right Arrow) Moves the cursor to the start of the next full word to the right of its current position. Will NOT "wrap" at column 80. See "Cursor Left One Word", above. CURSOR RIGHT TO END OF LINE Key: "End" The cursor is moved to the first blank character following the last non-blank character in the current cursor line. Cursor Movement - 14 Full Screen Editor - Version 2.0 TAB RIGHT Key: Tab (unshifted) Format mode dependent. Causes the cursor to be advanced to the next tab position to the right. Normally, this position is every eight characters, but in "Indented" mode is every four characters. Cursor does NOT wrap. TAB LEFT Key: Tab (shifted) Same as "Tab Right", above, except direction is to the left. NEW LINE Key: Enter Causes cursor to move down one row, and to column 1 of the new line. If position was in row 24, the new row will be 1. This key has a unique signficance when in "Insert Line" mode. See "Insert Line" command for discussion. Cursor Movement - 15 Full Screen Editor - Version 2.0 CHARACTER MANIPULATION COMMANDS Character manipulation commands behave much like data entry and are concerned with inidividual characters on a single line. INSERT CHARACTER Key: "Ins" This command is a "toggle". When in normal mode, this command places you in "insert character" mode. When in "insert character" mode, you are returned to normal mode. Normal mode is flagged by an underscore cursor, while "insert mode" is flagged by a block cursor. When in "insert mode", characters keyed in as in normal data entry, force the current line to the right one character, and the entered character is "inserted" in the line. Characters forced off the right end of the line are "lost". DELETE CHARACTER Key: "Del" This command deletes one character. The line to the right of the cursor position is shifted left one position, and blanks are added to the end of the line. DELETE TO END OF LINE Key: CTRL("End") This command clears the line to the right of the cursor to blanks. Character Commands - 16 Full Screen Editor - Version 2.0 LINE MANIPULATION COMMANDS Line manipulation commands include line insertion, deletion, movement, and copy. Deletion, movement, and copy may be applied to a single line, or to a block of contiguous lines. Line com- mands force screen changes to the file in memory INSERT LINE Key: F1 To insert a new line, simply position the cursor to the line following the desired insertion point, and depress function key 1. The existing display will "open" at that point, and a blank line will be displayed with the cursor positioned to the start of the blank line. Using cursor positioning and data entry, the new line can be built. When the new line has been entered properly, depress the "Enter" key, and an additional blank line for inser- tion will be displayed after the line which was inserted. This process may be continued indefinitely, entering a sequence of consequtive new lines. When the process is complete, simply depress "Enter" without keying data into the "new line" dis- played. The screen will "close" over the "new line" and you have returned to normal mode. Note that the "next" insert line is placed following the line on which the cursor is positioned at the time the "Enter" key is depressed. Normally, you simply key in the data for a new line, lines to be inserted in the proper sequence. Ocassionally, however, you may desire to enter a single new line at one posi- tion on the screen, and another line (or series of lines) at another position. By positioning the cursor "above" the second insert point before depressing the "Enter" key, you may perform this process without re-entering the F1 command. If you desire to enter a new line as the last line of the file, simply position the cursor to the "flag" line ("End of file") and depress F1. This method is that used when you are creating a new file. Initially, the screen is blank except for the "flag" line. Position the cursor to the "flag" line and depress the F1 key. The top line of the screen will be blanked, and you may initiate the entry process on that line. To generate a new line which is blank, perform the normal "Insert line" command. On the new line, enter at least one blank character before depressing "Enter". Delete, Move and Copy These line manipulation commands follow a common pattern which is described here for reference. All may deal with a "block" of lines, and the mechanism for demarking the "block" is given here. Note that a single line is simply a limited "block" so this discussion applies to all cases. Line Commands - 17 Full Screen Editor - Version 2.0 To demark a block of lines (and to initiate the command), simply position the cursor to the first/last line of the block and depress the appropriate command key. The editor will then prompt for the second limit of the block, so position the cursor to the last/first line of the block and again depress the same command key. In the case of move or copy, an additional prompt will be issued, requesting identification of the desired insertion point for the block of lines moved or copied. Simply position the cursor to the line AFTER the desired insertion point, and depress the command key for the third time. For move and copy, the insertion point must be within or at the file boundaries, and may not be within the range of lines demarked as the "block". Either case is sensed as an error and an appropriate error message will appear on the prompt line. DELETE LINE(S) Key: F2 Demark the lines to be deleted, as described above, depress- ing the function key 2 each time. Upon the second boundary specification, the block specified will be removed from the file and the display "refreshed" to the screen displayed when the "topmost" boundary was selected. MOVE LINE(S) Key: F3 Demark the block of lines to be moved, as described above. When the insertion point is indicated, the lines will be moved and the screen "refreshed" to the position displayed when the insertion point was selected. COPY LINE(S) Key: F4 Same as Move Lines, except the block is not removed from its original position in the file. Line Commands - 18 Full Screen Editor - Version 2.0 SEARCH COMMANDS There are two "search" commands supported by the editor: Find and Substitute. An additional command, Repeat, allows you to "repeat" the most current "search" command without re-entering the command. Use of "Repeat" permits rapid scanning through an entire file for a particular string. If a "search" string cannot be found, a message will appear in the prompt area, displaying the search string, and the words "not found". Searches are performed on an exact character by character match. Case is important, as are blanks and/or tabs. ABC(blank) is NOT the same as ABC(tab). Similarily, the string ALE is to be found in the string PALE, but the string (blank)ALE is not. Strings are limited to 20 characters. (Appendix C) FIND Key: F5 The editor will prompt for a search string (terminated by an "enter"), and will search the file from the current cursor posi- tion, forward through the file. The first "match" found will be displayed as the top line of the display, and the cursor will be positioned to the first character of the matching string. SUBSTITUTE Key: F6 Same as Find, except the editor will prompt for a second string. This string is to replace the search string, if a match is achieved. If the replacement string is shorter than the search string, the line is truncated. If longer, the line is extended. Characters "shifted" off the right end of the line by this extension are "lost". The resultant display is the same as for "Find", except in this case, the displayed string is the replacement string. This displayed replacement is a "screen change" only at this point, therefore depressing the Cancel key will cause the original data to be restored. Any other command will cause the replacement data to become part of the file. REPEAT Key: F7 Repeats the last "search" command. Note that the use of the "Cancel" command, as described under "Substitute", is applicable, allowing for selective substitution of a value throughout a file. Search Commands - 19 Full Screen Editor - Version 2.0 FILE CONTROL COMMANDS Primary input and output files of normal size are handled automatically by the editor, and require no commands for their support (See "Starting Out"). The commands in this section, then, are primarily concerned with auxillary file operations. Two types of "auxillary" files are recognized: "Insert" and "Extract". Both are normal ASCII source files which may or may not have been created by the editor. An "Insert" file is simply a file containing source that you wish to have inserted in the file being edited. An "Extract" file is a file that is created (extracted) from the file you are editing. As many "inserts" and "extracts" may be performed during an edit, as you desire. The only constraint is that only one "extract" file may be "open" at a time. INSERT EXTERNAL FILE Key: ALT(F1) You simply position the cursor to the line following the point of insert, and depress and hold the "Alt" key followed by a depression of function key 1. The editor will prompt for the name of the insert file (optional drive:name.type), and then will load the file at the desired insertion point. Note that the entire file is loaded. If the file cannot be found on the disk specified, an error prompt is issued. If sufficient memory space is not available to load the entire "insert" file, as much as can be contained will be loaded, and an error prompt will be dis- played.(Appendix D) EXTRACT EXTERNAL FILE Key: ALT(F2) Similar to the "line manipulation commands", extract expects a "block" of source to be delineated. Position the cursor to the first/last line of the block and depress key 2. If an active "extract" file is not already open, the system will prompt for the name of the "extract" file you are creating. If you provide a name that already exists on the disk, the editor will prompt for permission to over-write the file before proceeding. You are then prompted to position the cursor to the last/first line of the block, and again depress key 2. The desired block is written to the "extract" file. The source file being edited is unchanged by this operation, so if you really want to remove the lines from the existing file, you must now do a "delete lines" command. Once opened, "extract files" remain open until specifically "closed" by you, or until end of processing by the editor (See "End" command). If you perform additional "extracts", the result is simply appended to the end of the active extract file permit- ting you to build a file containing scattered segments of code extracted from various portions of the file being edited. File Control - 20 Full Screen Editor - Version 2.0 CLOSE EXTRACT FILE Key: ALT(F9) This command simply "closes" an active "Extract file". The next use of "extract" will require specification of another "extract file" to receive the source lines extracted. If a file is not active, then an information message is provided. Note that "Close" is needed only if more than a single extract file is to be produced by the editor. "End" automatically closes any open extract files. SPILL PRIMARY FILE Key: ALT(F3) As discussed in Appendix B, this command is used only when a primary input file is too large to be contained in the memory buffer. It is used to force output of the current memory buffer and the automatic load of the next portion of the primary input file. The "End" command causes an automatic "Spill" if needed. File Control - 21 Full Screen Editor - Version 2.0 EDITOR CONTROL COMMANDS These commands are primarily "housekeeping" commands, allow- ing control of some of the editor options, and generally control- ling the entire process. END COMMAND Key: F10 This command is issued at the normal end of the edit pro- cess. It causes the system to perform the write out of the memory buffer to the new primary file, performs the necessary file re- naming operations, closes any active "extract" files, clears the screen, and returns to the DOS. FORCE CHANGES Key: F9 This command simply forces any "screen changes" to the file in memory. CANCEL CHANGES/COMMANDS Key: F8 This command will cancel any "screen changes", restoring the screen values to their original form. It will also cancel any partially completed command (eg: move, copy, delete). It does NOT reset the search string for the "search" commands. CANCEL EDIT Key: ALT(F10) This command permits "cancelation" of the edit processor. When entered, the editor will first request verification of the desire to cancel, and then on a positive response, will effect- ively restore the system files to their status at the start of editing. The single exception to this, is that extract files formed during the edit and closed prior to cancelation, will remain on the disk. SET FORMAT Key: ALT(F5) This command sets the "format" process performed by the editor. The editor defaults to "Assembler", but you may change the format through this command, to either "Text" or "Indented". Depressing this key will cause the editor to issue a prompt, requesting you to respond with an "A", "T", or "I". Processing will then be performed in this format until the format is reset by this command, or until the editor is "reloaded". Details of the "formats" may be found in Appendix C. The esential differences are: Assembler will compress out blanks by tab substitution where ever possible (except for quoted strings). This blank surpression is performed in such a manner as to preserve the exact appearance that you formed when you entered the line originally. Tabs in Assembler are every 8 character positions across the screen. "Text" format permits blank surpression only at leading and Editor Control - 22 Full Screen Editor - Version 2.0 trailing ends of the line. No internal tab substitution will be made. Tabs in "text" mode are every 8 characters. One command, "Pack", is only applicable to "text" format. "Indented" format, like text, only permits blank supression at leading and trailing ends of the line. No internal tab sub- sitution will be made. Tabs in "Indented" mode are every 4 characters. Two commands, "Indent" and "De-indent", are applic- able only to "indented" format. Which ever format is selected, the current format is displayed on the prompt line (F: x). Editor Control - 23 Full Screen Editor - Version 2.0 MISCELLANEOUS COMMANDS The "catch-all" category, these commands have unique chract- eristics that do not readily cluster with the previous commands. Unless otherwise noted, these commands force changes. HELP MENUS Key: ALT("H") or ALT("h") The "help" command simply causes the display of a brief form of all commands available to the editor. The first screen con- tains the bulk of the heavily used commands, and return to the edit function may be made directly from that screen. A second option is to continue to the second menu containing the balance of the editor commands. Exit from this screen is always back to the edit function. The edit screen is unchanged by this action. CENTER LINE Key: ALT("C") or ALT("c") This command centers the string defined by the first and last non-blank characters on the current cursor position line. This command is a "screen change" only command and does not force changes to the file. PACK TEXT LINES Key: ALT(F4) This command functions only in "text" mode. The cursor is positioned to define a block of lines (see move/copy) and this process will then "pack" the lines within that block. The rule for packing is: Leading blanks/tabs on the first line of the block are not removed. Through the remainder of the block, all blanks and tabs, except for one blank after each word, are re- moved. Words are moved from line to line to follow this rule. The process treats the lines as if they were a continuous string of characters and then reformats as required to restore the line organization. This editor is not a text processor. Frequently, however, it is useful to be able to create a simple source file that can be directly read or printed. This facility assists in this process. For example, if you need to insert or delete words from an existing paragraph, simply insert or delete as much as neces- sary, using new lines as required, but ignoring format. When you have completed your changes, then use this command to reformat the paragraph. INDENT BLOCK RIGHT Key: ALT(F8) Intended for use with high level languages and structured programs, this simple tool permits indentation for primitive block structuring. Define a block of lines by cursor positioning (see move/copy), and this command will shift all of the lines within the block, 4 characters right. Lines offset within the block will retain their same relative offset to the shifted block. Characters shifted off the "right end" of the line are "lost". Miscellaneous Commands - 24 Full Screen Editor - Version 2.0 DE-INDENT BLOCK LEFT Key: ALT(F7) Similar to the previous command, this command simply revers- es the direction shifted. It moves the defined block to the left 4 characters. SWITCH DISPLAY DEVICE Key: ALT("S") or ALT("s") This command simply causes the "other" display device to be used, assuming your configuration has both the Monochrome and Color/Graphics interfaces. Attempting to use the command with only one interface installed, will result in an error message. Note that no method exists for assuring that a display device is connected to the interface. If, for example, you have the color/graphics interface installed, but have no monitor connected, this command will cause the display to be "switched" even though you cannot see the result. You may "toggle" back and forth without data loss, but the command is only active during the actual editing process. It cannot be used while the "title" page is displayed. Miscellaneous Commands - 25 Full Screen Editor - Version 2.0 CONCLUSION This completes the available commands for the editor. Since the editor is powerful, the command set is rather large. A good rule of thumb, if you forget or are confused, is "try it and see what happens". Since you can always "Cancel Edit", even a catas- trophic error simply costs you a little time. The editor is designed to do what you would naturally expect, so a little experimentation will normally straighten out any problems. Fre- quent reference to the "help" screens will be assistive until you've developed a habit pattern. Once you've developed the proper usage patterns, you'll find your speed and productivity have increased. And that's the only reason for an editor! Conclusion - 26 Full Screen Editor - Version 2.0 ERROR MESSAGES Most of the messages displayed by the editor are informa- tional or directive messages. The few error messages are usually self expanatory. This section is included to provide a more comprehensive explanation of the possible cause of error. Each of the "error" type messages is shown, and the description of cause follows. "Range error - Command canceled" Occurs when dealing with a "block" operation. Either the limits of the block are outside the file, or the insertion point is overlapped by the block. Remember, the insertion point may not be the same as one of the block limits. "Nul search invalid - Command canceled" You have responded to the "find" or "substitute" command prompt with a zero length search string (immediate "enter"). You may not search for "no data", nor may you search for a carriage return/line feed combination. "No Extract File active" You have issued the "close" command and the editor found no open Extract File. This is actually closer to a "warning" mess- age than an error, and has no effect on processing. "Error writing/closing Extract File" This message is usually caused by insufficient space on the disk specified for extract output. It may also be caused by the disk directory being full. Try directing the output to the other drive, in a multi-drive system. Otherwise you must "end" the edit and create free space on the disk you wish to use. DO NOT attempt to change the output disk while the editor is active. "Memory overflow - Incomplete Insert" During an "insert file" operation, the available memory stack was filled. This error will leave your file in a "disturbed" state, since part of the insert will be achieved. Recovery will require "end" command processing, and then reload the file to complete your edit. This error should not occur unless you are dealing with extremely large files. "Error writing/closing Primary output" This error occurs when either there is insufficient space on the output disk or the directory is full. In normal (non- "spill") mode you may recover from this error. The editor will issue a prompt asking if you with to "abort" the run. A "N" response will cause the display of a prompt requesting you to depress any key when you have replaced the full diskette with an Error Messages - 27 Full Screen Editor - Version 2.0 empty one. This is the only permissable point for removal of the output disk while the editor is active. Replace the output disk with a work or scratch disk, and depress any key. The editor will save your new file on the replacement disk. NOTE: The primary input file and the "old" back up file (if any) will not be changed or renamed in this run. "Device not installed" You have attempted switching to the "other" display device, but the interface to support this device is not present in your system. Error Messages - 28 Full Screen Editor - Version 2.0 APPENDIX A - FILE NAME PROCESSING To gain insight into the way file names are utilized by the editor, let's consider the typical entry with a single file name specified on the command line that invokes the editor. Upon being loaded the editor will first attempt to open the file name provided. If this action is not successful, the editor believes that the user wishes to create a new file, and prompts for con- firmation of that case. If the open is successful, then the file name is "copied" to an output file control block. The "type" portion of the name is set to "$$$", and the resultant file name is "opened". If the open is successful, the editor believes that it is about to "write over" an existing file, and requests that the user confirm that action. If open is unsuccessful, then a file of the generated name is created. This file becomes the primary output file. At the conclusion of edit (normal "end"), the editor must now "correct" the file names currently existing on the disks. First, the editor searches for a file named the same as the primary files, but with a type of "BAK". If such a file is found, it is deleted. Then the primary input file is renamed so that its "type" is changed to "BAK". Finally, the primary output file is renamed, changing its "type" from "$$$" to the type specified for the primary input file originally. This complex process is required if maximum protection against data loss is to be achieved. Two minor points are raised by this discussion. First, it becomes apparent that the disk "free" space at the start of edit must equal or exceed the primary input file space PLUS all of the changes introduced by the edit. You will find, when editor has completed and returned to the DOS, that "free" space exists on the disk. It is at least equal to, and probably greater than, the space required by the input "back up" file at the initiation of the edit process. At one point in time, three versions of the file MAY exist simultaneously on the disk. The primary input file, its back up, and the new output file. If the output oper- ation finds it cannot complete because of inadequate disk space (or directory space), an error return and prompt is made. Recov- ery from this type of error is covered in another section of this document. Secondly, if you suffer some type of catastrophic "crash" during editing (eg: power failure, etc.), you will find that your primary input and back up files have not been disturbed. As you attempt to "re-edit" the file, you will receive the warning prompt that your output file already exists. If you are sure that this is the cause of that prompt, then you may safely over- write the output file. If you examine the disk directory you will find a zero length file, named after your primary input file, but with a type of "$$$". Deleting this file will elminate the warning prompt. Appendix A - 29 Full Screen Editor - Version 2.0 APPENDIX B - LARGE FILES To provide the very fast response enjoyed by the editor, the bulk of processing is performed in the main memory of the compu- ter. This places a constraint on the quantity of data (size of file) that is available for editing at any instant in time. This constraint is sufficiently large that users following good prog- ramming practices may ignore the constraint, however the limita- tion does exist and is directly related to the memory size of the configuration. In any configuration, the maximum file size for immediate availability is 64K. In a 64K configuration, this size is reduced substantially. Since it is a function of the DOS size, as well as the editor size, it will vary with different installations, however even in the small configuration, most source files may be edited without constraint. The key phrase in the previous paragraph is "at any instant in time". The editor will actually process any file that may be contained on a normal DOS disk, provided sufficient space exists on the disk to permit two copies of the file at one time. The editor will load from the primary input file until one of two conditions is reached. Either the end of file is encountered, or three fourths of the available memory is filled. In the former case, the entire file is available "at any instant in time", while in the latter, only the portion loaded is available. In the latter case, editing may be performed on the portion avail- able. When all desired changes have been made, the SPILL command may be issued. The edited portion of the file is written to the output file, and the next portion of the input file is loaded. Use of the SPILL command may be repeated until the entire file is edited, allowing editing of very large files in relatively small memory configuration systems. It should be emphasised, however, that the typical user may never utilize the SPILL command. Files are maintained in a very dense form, and a 48K file is a very large program module, typically exceeding the size recommended by good programming practices. The SPILL capability is included purely to eliminate the artificial constraint of memory limitations. * * * WARNING * * * Insufficient space on disk will cause an I/O error. When operating in "spill" mode, such an error is not recoverable, and changes made to that point in the edit will be lost. When "Spill" is required, a normal "End" command will force "spills" to occur until the entire file has been transferred. You are not required to continue "spilling" through the entire file. Only through the last change you wish to make during the edit. "Search" commands are effective only on the file in memory, so if you have a large file that forces the use of "spill", you must perform repetitive searches if you wish to examine the entire file. Appendix B - 30 Full Screen Editor - Version 2.0 Finally, the actual load of a file will continue until three fourths of the memory available for source is utilized. A 64K source stack, therefore, will contain a file of 48K size. The remaining quarter is reserved for file expansion as you make changes. Experience has taught that this space is sufficient. In some abnormal and highly unusual circumstances, this "growth" space may not be adequate. If such a condition is sensed, the editor will issue an error message. At this point, you should "end" your edit, and then begin again on the file. This "end" and restart will cause the growth buffer to be re-established so your editing can be completed normally. Appendix B - 31 Full Screen Editor - Version 2.0 APPENDIX C - FORMAT PROCESSORS Format processing is designed to provide the most "dense" file structure possible, while retaining the format and appearance of the file you originally entered. Any line changed during the edit is processed by a formatter. All formats perform the functions described in this paragraph. First, all leading blanks are compressed to leading "tab" characters plus as many blanks as are necessary to maintain the alinement of the dis- played line. Second, all trailing blanks are surpressed to the last non-blank character in the line, and carriage return/line feed characters are added. "Tab" characters are assumed every eight characters in this discussion. You should note that under the "Indented" format, the tab key may cause cursor advance by 4 characters, but that function is performed by software. In the file, the 8 character tab is standard. Essentially all utilities and languages assume an 8 character tab, so this convention is sufficient to assure compatability. In the case of "Assembler" format, an additional step is performed between the front and rear surpression cited in the previous paragraph. After all leading blanks are surpressed, the source statement scan continues, and all internal blanks are surpressed using the same rules as stated for leading blanks. An exception is noted, in that when a quoted string is encountered, no blank surpression will occur until the end of the string is found. This assures that literals are not compressed. The result of this process is a severly truncated source line. For example, a blank line is stored as two characters (carriage return/line feed), while a three character instruction starting with a tab position is stored as 6 characters (tab, three instruction characters, and carriage return/line feed). Most high level languages are not as agreeable to this type of severe compression, so the methods outlined in the first para- graph are used. The 4 character software tab for indentation of high level languages was chosen because it allows the use of the tab character at least half the time, to replace leading blank strings. Format Processors - 32 Full Screen Editor - Version 2.0 APPENDIX D - INSERT FILES Occassionally a source file created by some other process will not be accepted properly as an "Insert" file. For example, after "Insert" you could find that the portion of your original file that should follow the insert, has disappeared!! If this or any other unusual condition occurs while attempt- ing insert, simply load the file to be inserted as a primary input file, and then perform the normal "end" command. The "insert" should now work properly. This error condition occurs when the "insert" file contains extraneous non-display characters, such as "end of file" or nul characters. Some processes will include double "end of file" characters, for example, and this will cause problems when encountered in an "insert" file. Loading and saving the insert file under the editor will elminate most of this type of problem since the editor will tend to remove extraneous characters. If this procedure does not produce the desired results, then you must remove the "bad" characters by means external to the editor to resolve the problem. Appendix D - 33 Full Screen Editor - Version 2.0 QUICK REFERENCE SCROLLING: Page Up by increment: "PgUp" 13 by line: CTRL("PgUp") 13 to top of source: "Home" 13 Down by increment: "PgDn" 13 by line: CTRL("PgDn") 13 to bottom of source: CTRL("Home") 13 Set scrolling increment: ALT(F6) 13 CURSOR MOVEMENT: Up: Up arrow 14 Down: Down arrow (or CTRL(Enter)) 14 Left by character: Left arrow (Either) 14 by word: CTRL(Left arrow) (Key pad) 14 Right by character: Right arrow 14 by word: CTRL(Right arrow) 14 to end of line: "End" 14 Tab right: Unshifted tab key 15 left: Shifted tab key 15 New line: Enter key 15 CHARACTER: Insert (toggle): "Ins" key 16 Delete: "Del" key 16 Delete to end of line: CTRL("End") 16 LINE: Insert: "F1" 17 Delete: "F2" 18 Move: "F3" 18 Copy: "F4" 18 SEARCH: Find: "F5" 19 Substitute: "F6" 19 Repeat: "F7" 19 Quick Reference Full Screen Editor - Version 2.0 QUICK REFERENCE - CONTINUED FILE CONTROL: Page Insert external file: ALT(F1) 20 Extract external file: ALT(F2) 20 Spill primary file: ALT(F3) 21 Close extract file: ALT(F9) 21 EDITOR CONTROL: End: "F10" 22 Force changes: "F9" 22 Cancel changes/commands: "F8" 22 Cancel edit: ALT(F10) 22 Set format: ALT(F5) 22 MISCELANEOUS: "Help" Menus: ALT("H") 24 Center cursor line: ALT("C") 24 Pack text lines: ALT(F4) 24 Indent block right: ALT(F8) 24 De-indent block left: ALT(F7) 25 Swith Display device: ALT("S") 25 Quick Reference Full Screen Editor - Version 2.0 T.P.I.R. REGISTRATION/ORDER Date:__________________ Dan Daetwyler Route 5, Box 518A Springdale, Arkansas 72764 This is an (circle one) ORDER REGISTRATION for: Product Name:__________________________________________________ If an order, then check below: _____ I have enclosed diskette, mailer, and postage. _____ I have enclosed $7.50. Please send me the requested product, supplying a diskette, postpaid. Indicate shipping preference: UPS______ 1st class mail______ If a registration, then provide the following information: Version Number of product _______________________ Diskette directory date of product file __________________ Source of program: Name:__________________________________ Address:_______________________________ _______________________________ My name, address, and phone: ________________________________________________ ________________________________________________ ________________________________________________ ________-________-_____________ Registration fee: FSED - $35 SDA - $25 LIST - $25 36